

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Reference Documentation &mdash; geoslurp v1.1.0 documentation</title>
  

  
  
    <link rel="shortcut icon" href="_static/favicon.ico"/>
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="genindex.html"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="geoslurp v1.1.0 documentation" href="index.html"/>
        <link rel="next" title="Conventions on naming tables and their columns" href="tableconventions.html"/>
        <link rel="prev" title="Exporting parts of the database to portable formats" href="examples/export2Portable.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> geoslurp
          

          
          </a>

          
            
            
              <div class="version">
                1.1.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">An introduction to Geoslurp</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation of the geoslurp package and setting up the PostgreSQL instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="confsettings.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Tutorial</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Reference Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tableconventions.html">Conventions on naming tables and their  columns</a></li>
<li class="toctree-l2"><a class="reference internal" href="clitools.html">Command line tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/geoslurp.html">geoslurp package</a></li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">geoslurp</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>Reference Documentation</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/reference.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  
<style>
/* CSS overrides for sphinx_rtd_theme */

/* 24px margin */
.nbinput.nblast,
.nboutput.nblast {
    margin-bottom: 19px;  /* padding has already 5px */
}

/* ... except between code cells! */
.nblast + .nbinput {
    margin-top: -19px;
}

.admonition > p:before {
    margin-right: 4px;  /* make room for the exclamation icon */
}
</style>
<div class="section" id="reference-documentation">
<h1>Reference Documentation<a class="headerlink" href="#reference-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="tableconventions.html">Conventions on naming tables and their  columns</a></li>
<li class="toctree-l1"><a class="reference internal" href="clitools.html">Command line tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="clitools.html#clitools-geoslurper-py">clitools/geoslurper.py</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/geoslurp.html">geoslurp package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/geoslurp.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/geoslurp.config.html">geoslurp.config package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.config.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.config.html#module-geoslurp.config.catalogue">geoslurp.config.catalogue module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.config.html#module-geoslurp.config.localsettings">geoslurp.config.localsettings module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.config.html#module-geoslurp.config.slurplogger">geoslurp.config.slurplogger module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/geoslurp.datapull.html">geoslurp.datapull package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.crawler">geoslurp.datapull.crawler module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.ftp">geoslurp.datapull.ftp module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.geodesyunr">geoslurp.datapull.geodesyunr module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.github">geoslurp.datapull.github module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.http">geoslurp.datapull.http module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.icgem">geoslurp.datapull.icgem module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.motu">geoslurp.datapull.motu module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.rsync">geoslurp.datapull.rsync module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.thredds">geoslurp.datapull.thredds module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.uri">geoslurp.datapull.uri module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.datapull.html#module-geoslurp.datapull.webdav">geoslurp.datapull.webdav module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/geoslurp.dataset.html">geoslurp.dataset package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.ArcticDEM">geoslurp.dataset.ArcticDEM module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.Argo">geoslurp.dataset.Argo module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.CSVBase">geoslurp.dataset.CSVBase module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.DuacsGriddedDsets">geoslurp.dataset.DuacsGriddedDsets module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.GRACEDsets">geoslurp.dataset.GRACEDsets module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.GSHHGDsets">geoslurp.dataset.GSHHGDsets module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.IceSatDrainDiv">geoslurp.dataset.IceSatDrainDiv module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.OGRBase">geoslurp.dataset.OGRBase module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.PSMSL">geoslurp.dataset.PSMSL module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.RGIDsets">geoslurp.dataset.RGIDsets module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.RadsDsets">geoslurp.dataset.RadsDsets module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.RasterBase">geoslurp.dataset.RasterBase module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.TUGRAZDsets">geoslurp.dataset.TUGRAZDsets module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.dataSetBase">geoslurp.dataset.dataSetBase module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.deg1n2">geoslurp.dataset.deg1n2 module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.geodesyunr">geoslurp.dataset.geodesyunr module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.geoshapes">geoslurp.dataset.geoshapes module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.icgemDsets">geoslurp.dataset.icgemDsets module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.motuGridsBase">geoslurp.dataset.motuGridsBase module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.mss_cnes_cls2015">geoslurp.dataset.mss_cnes_cls2015 module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.naturalearth">geoslurp.dataset.naturalearth module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.orsiFronts">geoslurp.dataset.orsiFronts module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.pandasbase">geoslurp.dataset.pandasbase module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.snrei">geoslurp.dataset.snrei module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.swot_sim">geoslurp.dataset.swot_sim module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.wgms_fog">geoslurp.dataset.wgms_fog module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dataset.html#module-geoslurp.dataset.wribasin">geoslurp.dataset.wribasin module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/geoslurp.db.html">geoslurp.db package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.db.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.db.html#module-geoslurp.db.connector">geoslurp.db.connector module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.db.html#module-geoslurp.db.exporter">geoslurp.db.exporter module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.db.html#module-geoslurp.db.geoslurpdb">geoslurp.db.geoslurpdb module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.db.html#module-geoslurp.db.inventory">geoslurp.db.inventory module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.db.html#module-geoslurp.db.settings">geoslurp.db.settings module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.db.html#module-geoslurp.db.tabletools">geoslurp.db.tabletools module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/geoslurp.dbfunc.html">geoslurp.dbfunc package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dbfunc.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dbfunc.html#module-geoslurp.dbfunc.dbfunc">geoslurp.dbfunc.dbfunc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.dbfunc.html#module-geoslurp.dbfunc.radsfuncs">geoslurp.dbfunc.radsfuncs module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/geoslurp.discover.html">geoslurp.discover package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.discover.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="reference/geoslurp.discover.fesom.html">geoslurp.discover.fesom package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.fesom.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.fesom.html#module-geoslurp.discover.fesom.extractprofiles">geoslurp.discover.fesom.extractprofiles module</a></li>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.fesom.html#module-geoslurp.discover.fesom.fesomQuery">geoslurp.discover.fesom.fesomQuery module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="reference/geoslurp.discover.gravity.html">geoslurp.discover.gravity package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.gravity.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.gravity.html#module-geoslurp.discover.gravity.graceQuery">geoslurp.discover.gravity.graceQuery module</a></li>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.gravity.html#module-geoslurp.discover.gravity.staticQuery">geoslurp.discover.gravity.staticQuery module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="reference/geoslurp.discover.oceanobs.html">geoslurp.discover.oceanobs package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.oceanobs.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.oceanobs.html#module-geoslurp.discover.oceanobs.argoProfiles">geoslurp.discover.oceanobs.argoProfiles module</a></li>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.oceanobs.html#module-geoslurp.discover.oceanobs.argoQuery">geoslurp.discover.oceanobs.argoQuery module</a></li>
<li class="toctree-l6"><a class="reference internal" href="reference/geoslurp.discover.oceanobs.html#module-geoslurp.discover.oceanobs.psmsl">geoslurp.discover.oceanobs.psmsl module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/geoslurp.tools.html">geoslurp.tools package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.tools.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.tools.html#module-geoslurp.tools.Bounds">geoslurp.tools.Bounds module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.tools.html#module-geoslurp.tools.csv">geoslurp.tools.csv module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.tools.html#module-geoslurp.tools.gravity">geoslurp.tools.gravity module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.tools.html#module-geoslurp.tools.netcdftools">geoslurp.tools.netcdftools module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.tools.html#module-geoslurp.tools.ogrgeom">geoslurp.tools.ogrgeom module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.tools.html#module-geoslurp.tools.shapelytools">geoslurp.tools.shapelytools module</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/geoslurp.tools.html#module-geoslurp.tools.time">geoslurp.tools.time module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="tableconventions.html" class="btn btn-neutral float-right" title="Conventions on naming tables and their columns" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="examples/export2Portable.html" class="btn btn-neutral" title="Exporting parts of the database to portable formats" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Roelof Rietbroek.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'v1.1.0',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>